resource-inventory-management-biz

(0 reviews)

Reset Device

Key Considerations

Input body will contain service number and account number.
Equipments for account level and service level are retrieved from cerillion API.
After equipment/device validation, request is sent to RESOLVE to reset the Modem.

URL

https://[localhost]:[port]/tmf-api/resourceInventoryManagement/v1/{businessId}/reset

URI PARAMS

name	type	description	required
businessId	string	2 letter ISO 3166 country code (AG,BB,BS,GD,JM,LC,TT,VC,PR) identifying the business unit. Enum values:AG,BB,BS,GD,JM,LC,TT,VC,PR	Y

Headers

name	value	description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	N
lob	string	Enum: PREPAID, POSTPAID,FIXED Mobile users: PREPAID, POSTPAID Fixed users : FIXED	N
channelId	string	Channel to identify the business group. Eg:ECOM	N

Request Body

{
    "name": "Modem Reset Device",
    "relatedParty": [
        {
            "id": "30000486",
            "name": "AccountNumber"
        },
        {
            "id": "DA0000029666",
            "name": "ServiceNumber"
        }
    ]
}

Note: For Modem device, serviceType should be of DA,DS,IP. And for STB, serviceType should be of AV,DV,TV.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[200]-CWC-Success Response when deviceClass is Modem:

{
  "id": "31bf09cf5595d5d7b5a427c1faf239fb",
  "resourceStatus": "Success",
  "administrativeState": "unlocked",
  "resourceCharacteristic": [
    {
      "id": "9257708",
      "name": "Modem - Wireless",
      "value": "EQJAHDVM",
      "valueType": "tariffCode",
      "characteristicRelationship": [
        {
          "id": "90C792DD1582",
          "@type": "serialNo"
        },
        {
          "id": "31bf09cf5595d5d7b5a427c1faf239fb",
          "@type": "requestId"
        },
        {
          "id": "ivr_result#resolve.ivr.util",
          "@type": "operationCode"
        }
      ],
      "@type": "MODEM"
    }
  ],
  "relatedParty": [
    {
      "id": "DA0000029666",
      "@type": "ServiceNo"
    },
    {
      "id": "12626702",
      "@type": "AccountNo"
    }
  ]
}

[ 200 ]-CWC-Success Response for STB when resettable is true:

OK - Resource request processed successfully, response body contains an entity corresponding to the requested resource.

{
  "id": "0",
  "resourceStatus": "Success",
  "administrativeState": "unlocked",
  "resourceCharacteristic": [
    {
      "id": "12401156",
      "name": "set top box",
      "value": "EQPVRSTB",
      "valueType": "tariffCode",
      "characteristicRelationship": [
        {
          "id": "PAAT00069709",
          "@type": "serialNo"
        },
        {
          "id": "24707576",
          "@type": "requestId"
        },
        {
          "id": "STBWR",
          "@type": "operationCode"
        }
      ],
      "@type": "STB"
    },
    {
      "id": "12401157",
      "name": "set top box",
      "value": "EQPVRSTB",
      "valueType": "tariffCode",
      "characteristicRelationship": [
        {
          "id": "PAER00488122",
          "@type": "serialNo"
        },
        {
          "id": "24707578",
          "@type": "requestId"
        },
        {
          "id": "STBWR",
          "@type": "operationCode"
        }
      ],
      "@type": "STB"
    }
  ],
  "relatedParty": [
    {
      "id": "DV0000002224",
      "@type": "ServiceNo"
    },
    {
      "id": "14552101",
      "@type": "AccountNo"
    }
  ]
}

[200]-CWC-Success Response for STB when resettable is false:**

{
  "id": "na",
  "resourceStatus": "Success",
  "administrativeState": "unlocked",
  "resourceCharacteristic": [
    {
      "id": "11389589",
      "name": "set top box",
      "value": "EQJAHSTB",
      "valueType": "tariffCode",
      "characteristicRelationship": [
        {
          "id": "H40CO0164578",
          "@type": "serialNo"
        },
        {
          "id": 0,
          "@type": "requestId"
        },
        {
          "id": "STBWR",
          "@type": "operationCode"
        }
      ],
      "@type": "STB"
    }
  ],
  "relatedParty": [
    {
      "id": "DV0001574453",
      "@type": "ServiceNo"
    },
    {
      "id": "14552101",
      "@type": "AccountNo"
    }
  ]
}